﻿//////////////////////////////////////////////////////////////////////////////
//
//  Copyright © 1998-2024 Glodon Company Limited.  All rights reserved.
//
//  Use of this software is subject to the terms of the Glodon license
//  agreement provided at the time of installation or download, or which
//  otherwise accompanies this software in either electronic or hard copy form.  
//
//////////////////////////////////////////////////////////////////////////////


#pragma once

#include "GcmpModelInterface.h"
#include "IDbObject.h"

namespace gcmp
{
    class IDocument;
    class IParameterDefinition;
    class IExternalParameterDefinitionBinding;
    enum class ExternalParameterType;

    /// \brief 外部参数定义类
    class GCMP_MODEL_INTERFACE_EXPORT IExternalParameterDefinition : public gcmp::IDbObject
    {
        DEFINE_CAST_DERIVED(gcmp::IExternalParameterDefinition, gcmp::IDbObject);
    public:

        /// \brief 获取参数定义Id
        /// \return 参数定义Id
        virtual int GetParameterDefinitionId() const = 0;

        /// \brief 获取参数类型
        /// \return 参数类型
        virtual ExternalParameterType GetParameterType() const = 0;

        /// \brief 获取参数定义对象
        /// \return 参数定义对象
        virtual const gcmp::IParameterDefinition* GetParameterDefinition() const = 0;

        /// \brief 获取是否用户可修改
        /// \return true用户可修改，false不可修改。
        virtual bool IsUserModifiable() const = 0;

        /// \brief 获取是否用户可见
        /// \return true用户可见，false不可见。
        virtual bool IsUserVisible() const = 0;

        /// \brief 获取外部参数定义绑定对象
        /// \return 外部参数定义绑定对象
        virtual const IExternalParameterDefinitionBinding* GetBinding() const = 0;
    };

}
